﻿using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml.Linq;

namespace SiteMonitorLogic
{
    /// <summary>
    /// Interface that defines a site check (test).  The constructor of a class that implements this
    /// should accept a single argument of type XElement.
    /// </summary>
    public interface ICheck
    {
        /// <summary>
        /// A short string that describes what this check does.  Usually just returns a const string for this type of check.
        /// </summary>
        string DisplayType { get; }

        /// <summary>
        /// A short string to display to the user.  IE: ContentCheck returns the Uri of the page it requests.
        /// </summary>
        string Name { get; }

        /// <summary>
        /// A short string to display to the user.  IE: ContentCheck returns the Uri of the page it requests.
        /// </summary>
        string Info { get; }

        /// <summary>
        /// Runs this check and returns the result.
        /// </summary>
        /// <returns></returns>
        CheckResult Execute();
    }
}
